﻿using System;
using System.Collections.Generic;
using System.Text;

namespace SMBL.Interface.Document
{
    /// <summary>
    /// Interface Document Editable
    /// This interface is used to provide the function to write file.
    /// This interface can only be inheirt by IDocProcessor.
    /// @Author: Push
    /// </summary>
    public interface IDocEdit
    {
        /// <summary>
        /// Write the content into the file.
        /// This operation should discard whether the file is empty or not.
        /// @Author: Push
        /// </summary>
        /// <param name="Content">The content to be writen into the file</param>
        void Write(String Content);

        /// <summary>
        /// Append some strings to the file.
        /// This operation will not change any thing in the file.
        /// @Author: Push
        /// </summary>
        /// <param name="Content">The content to be writen into the file</param>
        void Append(String Content);

        /// <summary>
        /// Read one line from the opened file.
        /// The point should be moved to the next line.
        /// @Author: Push
        /// </summary>
        /// <returns></returns>
        String ReadLine();

        /// <summary>
        /// Read all content from the opened file.
        /// The content should be started from the last read point.
        /// @Author: Push
        /// </summary>
        /// <returns></returns>
        String RealToEnd();
    }
}
